package 使用注释�﷨;


Javaע�ͼ��
��Java��˵��ע�ͣ�������Ҫ��֪��ʲô��Ԫmetadata������������ǹ���һ�㷭��ΪԪ���ݣ���νԪ���ݣ��������ݵ����ݡ�Ҳ����˵��Ԫ���ݴ��ڵ����壬
����Ϊ���������ݡ�����Ԫ���ݵĸ����Ժ����ǾͿ��԰�ע�ͳ���Java�����Ԫ���ݡ�

����
�����е�ע���ǳ��������������Ķ���֮��ͨ�ŵ���Ҫ�ֶΡ�Ӧ��ע�͹淶���������������������Ա������Ϊ��Ҫ�����������е����ݿ���˼�����Ѿ�����˽�ע��ת
Ϊ����ĸ���õ�ע�͹淶���Ծ����ܵļ���һ�������ά���ɱ� , ���Ҽ���û���κ�һ������������������������У���������Ŀ�����Ա��ά�����õ�ע�͹淶����
��������Ŀɶ��ԣ������ÿ�����Ա��������׵�����µĴ��롣�õ�ע�͹淶��������޶ȵ�����Ŷӿ����ĺ���Ч�ʡ����ڵĹ淶�Ա��뻹�����ÿ�����Ա�������õı�
��ϰ�ߣ����������������Ͻ���˼ά������ 

����
1������(single-line)--��ע�ͣ�//����   
������ע�ͣ��ڴ����е���һ��ע�ͣ� ע��ǰ�����һ�п��У��������Ĵ������һ���������㼶����������޷���ɣ���Ӧ���ÿ�ע�͡�
ע�͸�ʽ��/* ע������ */

��ͷע�ͣ��ڴ����еĿ�ͷ����ע�͡���ҪΪ��ʹ���д���ʧȥ���塣
ע�͸�ʽ��// ע������

��βע�ͣ�β��(trailing)--���̵�ע�ͣ��ڴ����е���β����ע�͡�һ��������к��8������4����������ע�ͱ�����롣
ע�͸�ʽ������ + 8������4�����ո� + // ע������

2����(block)--��ע�ͣ�/*����*/
ע�������У�ͨ�������ṩ�ļ������������ݽṹ�ȵ���������;��˵���������㷨��������һ��λ��һ���ļ�����һ��������ǰ�棬�����������ã�Ҳ���Ը�����Ҫ���ں���
��λ�á�������ע�Ͳ��������HTML�����С�ע�͸�ʽͨ��д�ɣ�
/*
  * ע������
  */ 

3���ĵ�ע�ͣ�/**����*/
ע�������У���д��javadoc�ĵ���ÿ���ĵ�ע�Ͷ��ᱻ����ע�Ͷ����
/**......*/֮�У�ע���ĵ�����������HTML��ʽ�Ĵ��뱨�棬����ע���ĵ�������д���ࡢ�򡢹��캯�����������Լ��ֶ�(field)����֮ǰ��ע���ĵ�����������ɡ������������ǡ�
     <1>�ĵ����ĵ�ע�͵ĸ�ʽ��
               ��Ϊ���ɵ��ĵ���HTML ��ʽ�����Ը�ʽ���ĵ�������ע�ͼ������Ӧ��HTML ��ʶ
               ע�⣺�ĵ�ע��ֻ˵�����������ࡢ���Ի��߷�����
      <2>ע�͵�������
               eg��
                /**
       * show �����ļ���.
           * <p>show ��������ϸ˵����һ��<br>
           * show ��������ϸ˵���ڶ���
           * @param b true ��ʾ��ʾ��false ��ʾ����
           * @return û�з���ֵ
           */ public void show(boolean b) {
              frame.show(b);
          }
                ��һ�����Ǽ������ĵ��У��������Ժͷ�����������һ���б�Ȼ����ں���һ��һ������ϸ��˵�����б������������߷����������Ƕ�˵�����Ǽ�����
                �ڶ���������ϸ˵�����֡��ò��ֶ����Ի��߷���������ϸ��˵�����ڸ�ʽ��û��ʲô�����Ҫ�󣬿��԰������ɸ���š�
                ��������������˵�����֡��ⲿ�ְ����汾˵��������˵��������ֵ˵���ȡ�
��ǩ�﷨
javadoc ����ǲ����ĵ�ע���е������ǣ��������ڱ�ʶ�����е��������á�javadoc ����ɡ�@������������ı�����ͺ�ר��ע��������ɡ���ס�ˣ��������֣�@��������͡�ר��ע�����á�
@author    �����˵�� ������������ģ�������
@version   �����˵�� ��������ģ��İ汾
@see      ���ࡢ���ԡ�������˵�� �ο�ת��Ҳ�����������
@param    �Է�����˵�� �Է�����ĳ������˵��
@return    �Է�����˵�� �Է�������ֵ��˵��
@exception  �Է�����˵�� �Է��������׳����쳣����˵�� 
�淶
1�� ע����ʽͳһ 
������Ӧ�ó����У�ʹ�þ���һ�µı��ͽṹ����ʽ������ע�͡������������Ŀ�鷢�����ǵ�ע�͹淶������ĵ���ͬ���������ǵĹ淶д���룬��Ҫ��ͼ�ڼȳɵĹ淶ϵͳ�������µĹ淶�� 
2�� ע�͵ļ�� 
����Ҫ�򵥡����ˡ�����׼ȷ����ֹע�͵Ķ����ԣ������ע�Ͳ������淴���к��� 
3�� ע�͵�һ���� 
��д����֮ǰ���߱�д�����дע�ͣ���Ϊ�Ժ�ܿ���û��ʱ���������������⣬����л��Ḵ���ѱ�д�Ĵ��룬�ڽ��쿴�������ԵĶ��������Ժ����Ͳ������ˡ�ͨ��������ע�����ڴ��봴����������ע���ڿ��������д�������ʾ��ע���ڴ������֮�󴴽����޸Ĵ����ͬʱ�޸���Ӧ��ע�ͣ��Ա�֤������ע�͵�ͬ���� 
4�� ע�͵�λ�� 
��֤ע�����������Ĵ������ڣ���ע�͵ľͽ�ԭ�򡣶Դ����ע��Ӧ�������Ϸ����ڻ��ҷ���λ�ã����ɷ����·��������ڴ����е�ĩβ���ע�ͣ���βע��ʹ��������Ķ�����������ע��������ʱ����βע���Ǻ��ʵģ�����������£���������βע��Ҫ���롣 
5�� ע�͵����� 
ע�ͱز����٣���Ҳ��Ӧ���࣬��ʵ�ʵĴ���淶�У�Ҫ��ע��ռ�������ı����ﵽ20%���ҡ�ע���ǶԴ���ġ���ʾ�����������ĵ��������е�ע�Ͳ�������������ע��̫���˻������ۻ����ң�ע�͵Ļ���Ҫ�١���Ҫ������Ϊдע�Ͷ�дע�͡� 
6��ɾ������ע�� 
�ڴ��뽻�����𷢲�֮ǰ������ɾ����ʱ�Ļ��޹ص�ע�ͣ��Ա������պ��ά�������в������ҡ� 
7�� ���ӵ�ע�� 
�����Ҫ��ע�������͸��ӵĴ��룬����˴�����ȷ���Ƿ�Ӧ����д������һ�п��ܲ�ע���������Ĵ��룬��Ӧ����д��������һ�㲻Ӧ��Ϊ��ʹ������򵥱���ʹ�ö��������ܣ������뱣�����ܺͿ�ά����֮���ƽ�⡣ 
8�� �����ע�� 
���������ܺͳ������ɲ����໥��ϵ�ĸ߼�ע���������õģ������н��ͳ�����ι����ĵͼ�ע�������ڶ���д���޸ģ��ǲ���Ҫ�ģ�Ҳ������ά���ġ�����ÿ�д��붼ʹ��ע�͡�������뱾�����������һĿ��Ȼ���򲻼�ע�ͣ��������Ļ��ʵ���ע�ͳ��֡� 
9���ؼӵ�ע�� 
�����㷨������ע�͡��ڴ��벻�����򲻿���ֲ��������ע�͡��ڴ����޸Ĵ������޸ı�ʶ��ע�͡���ѭ�����߼���֧��ɵĴ��������ע�͡�Ϊ�˷�ֹ���ⷴ�����֣��Դ����޸��ͽ�������Ĵ���ʹ��ע�ͣ����������Ŷӻ����С� 
10��ע���ڱ������ʱ�ᱻ���ԣ������뵽���Ŀ�ִ���ļ��У�����ע�Ͳ� �����ӿ�ִ���ļ��Ĵ�С�� 

����ģ��
����(Types)ע�ͱ�ǩ�����ע�ͣ���

/** 
* @ClassName: ${type_name} 
* @Description: ${todo} 
* @author A18ccms a18ccms_gmail_com 
* @date ${date} ${time} 
* 
* ${tags} 
*/

�ֶ�(Fields)ע�ͱ�ǩ��

/** 
* @Fields ${field} : ${todo} 
*/ 
���캯��ע�ͱ�ǩ��

/** 
* <p>Title: </p> 
* <p>Description: </p> 
* ${tags} 
*/

����(Constructor & Methods)ע�ͱ�ǩ��

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo} 
* @param ${tags}    �趨�ļ� 
* @return ${return_type}    �������� 
* @throws 
*/

����
��/�ӿ�ע��
/**
 * The <code>String</code> class represents character strings. All
 * string literals in Java programs, such as <code>"abc"</code>, are
 * implemented as instances of this class.
 * (��������)
 * @author Lee Boynton
 * @author Arthur van Hoff
 * @author Martin Buchholz
 * @author Ulf Zibis
 * @see java.lang.Object#toString()
 * @see java.lang.StringBuffer
 * @see java.lang.StringBuilder
 * @see java.nio.charset.Charset
 * @since JDK1.0
 */ public final class String implements java.io.Serializable, Comparable<String>, CharSequence { ...
}
������ע��
/**
     * Initializes a newly created {@code String} object so that it represents
     * the same sequence of characters as the argument; in other words, the * newly created string is a copy of the argument string. Unless an
     * explicit copy of {@code original} is needed, use of this constructor is * unnecessary since Strings are immutable.
     *
     * @param  original
     *         A {@code String}
     */
    public String(String original) {
        this.value = original.value;
        this.hash = original.hash;
    }
����ע��
/**
     * Returns <tt>true</tt> if, and only if, {@link #length()} is <tt>0</tt>.
     *
     * @return <tt>true</tt> if {@link #length()} is <tt>0</tt>, otherwise
     * <tt>false</tt>
     *
     * @since 1.6
     */ public boolean isEmpty() { return value.length == 0;
    }
�ֶ�/����ע��
/** The value is used for character storage. */ private final char value[]; /** Cache the hash code for the string */ private int hash; // Default to 0 /** use serialVersionUID from JDK 1.0.2 for interoperability */ private static final long serialVersionUID = -6849794470754667710L; /**
     * Class String is special cased within the Serialization Stream Protocol.
     *
     * A String instance is written initially into an ObjectOutputStream in the
     * following format:
     * <pre>
     *      <code>TC_STRING</code> (utf String)
     * </pre>
     * The String is written by method <code>DataOutput.writeUTF</code>.
     * A new handle is generated to  refer to all future references to the
     * string instance within the stream.
     */ private static final ObjectStreamField[] serialPersistentFields = new ObjectStreamField[0];